<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SQLBuilder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/util/SQLBuilder.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/util/package-summary.html">org.apache.torque.util</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.HashSet;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Iterator;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.List;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Map;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Set;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.torque.Torque;
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.torque.TorqueException;
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.torque.adapter.DB;
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.torque.map.ColumnMap;
<a name="35" href="#35">35</a>  <strong>import</strong> org.apache.torque.map.DatabaseMap;
<a name="36" href="#36">36</a>  <strong>import</strong> org.apache.torque.util.Criteria.Criterion;
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>  <em>/**<em>*</em></em>
<a name="39" href="#39">39</a>  <em> * Factored out code that is used to process SQL tables. This code comes</em>
<a name="40" href="#40">40</a>  <em> * from BasePeer and is put here to reduce complexity in the BasePeer class.</em>
<a name="41" href="#41">41</a>  <em> * You should not use the methods here directly!</em>
<a name="42" href="#42">42</a>  <em> *</em>
<a name="43" href="#43">43</a>  <em> * @author &lt;a href="<a href="mailto:hps@intermeta.de" target="alexandria_uri">mailto:hps@intermeta.de</a>">Henning P. Schmiedehausen&lt;/a></em>
<a name="44" href="#44">44</a>  <em> * @author &lt;a href="<a href="mailto:fischer@seitenbau.de" target="alexandria_uri">mailto:fischer@seitenbau.de</a>">Thomas Fischer&lt;/a></em>
<a name="45" href="#45">45</a>  <em> * @version $Id: SQLBuilder.java 535596 2007-05-06 10:47:39Z tfischer $</em>
<a name="46" href="#46">46</a>  <em> */</em>
<a name="47" href="#47">47</a>  <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../org/apache/torque/util/SQLBuilder.html">SQLBuilder</a>
<a name="48" href="#48">48</a>  {
<a name="49" href="#49">49</a>      <em>/**<em>* Logging */</em></em>
<a name="50" href="#50">50</a>      <strong>protected</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(SQLBuilder.<strong>class</strong>);
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>      <em>/**<em>* Function Characters */</em></em>
<a name="53" href="#53">53</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String[] COLUMN_CHARS = {<span class="string">"."</span>, <span class="string">"*"</span>};
<a name="54" href="#54">54</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String[] DELIMITERS = {<span class="string">" "</span>, <span class="string">","</span>, <span class="string">"("</span>, <span class="string">")"</span>, <span class="string">"&lt;"</span>, <span class="string">">"</span>};
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <em>/**<em>*</em></em>
<a name="57" href="#57">57</a>  <em>     * Private constructor to prevent instantiation.</em>
<a name="58" href="#58">58</a>  <em>     *</em>
<a name="59" href="#59">59</a>  <em>     * Class contains only static method ans should therefore not be</em>
<a name="60" href="#60">60</a>  <em>     * instantiated.</em>
<a name="61" href="#61">61</a>  <em>     */</em>
<a name="62" href="#62">62</a>      <strong>private</strong> <a href="../../../../org/apache/torque/util/SQLBuilder.html">SQLBuilder</a>()
<a name="63" href="#63">63</a>      {
<a name="64" href="#64">64</a>      }
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      <em>/**<em>*</em></em>
<a name="67" href="#67">67</a>  <em>     * Fully qualify a table name with an optional schema reference</em>
<a name="68" href="#68">68</a>  <em>     *</em>
<a name="69" href="#69">69</a>  <em>     * @param table The table name to use. If null is passed in, null is returned.</em>
<a name="70" href="#70">70</a>  <em>     * @param dbName The name of the database to which this tables belongs.</em>
<a name="71" href="#71">71</a>  <em>     *               If null is passed, the default database is used.</em>
<a name="72" href="#72">72</a>  <em>     *</em>
<a name="73" href="#73">73</a>  <em>     * @return The table name to use inside the SQL statement. If null is passed</em>
<a name="74" href="#74">74</a>  <em>     *         into this method, null is returned.</em>
<a name="75" href="#75">75</a>  <em>     * @exception TorqueException if an error occurs</em>
<a name="76" href="#76">76</a>  <em>     */</em>
<a name="77" href="#77">77</a>      <strong>public</strong> <strong>static</strong> String getFullTableName(
<a name="78" href="#78">78</a>              <strong>final</strong> String table,
<a name="79" href="#79">79</a>              <strong>final</strong> String dbName)
<a name="80" href="#80">80</a>          throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="81" href="#81">81</a>      {
<a name="82" href="#82">82</a>          <strong>if</strong> (table != <strong>null</strong>)
<a name="83" href="#83">83</a>          {
<a name="84" href="#84">84</a>              <strong>int</strong> dotIndex = table.indexOf(<span class="string">"."</span>);
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>              <strong>if</strong> (dotIndex == -1) <em class="comment">// No schema given</em>
<a name="87" href="#87">87</a>              {
<a name="88" href="#88">88</a>                  String targetDBName = (dbName == <strong>null</strong>)
<a name="89" href="#89">89</a>                          ? Torque.getDefaultDB()
<a name="90" href="#90">90</a>                          : dbName;
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>                  String targetSchema = Torque.getSchema(targetDBName);
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>                  <em class="comment">// If we have a default schema, fully qualify the</em>
<a name="95" href="#95">95</a>                  <em class="comment">// table and return.</em>
<a name="96" href="#96">96</a>                  <strong>if</strong> (StringUtils.isNotEmpty(targetSchema))
<a name="97" href="#97">97</a>                  {
<a name="98" href="#98">98</a>                      <strong>return</strong> <strong>new</strong> StringBuffer()
<a name="99" href="#99">99</a>                              .append(targetSchema)
<a name="100" href="#100">100</a>                             .append(<span class="string">"."</span>)
<a name="101" href="#101">101</a>                             .append(table)
<a name="102" href="#102">102</a>                             .toString();
<a name="103" href="#103">103</a>                 }
<a name="104" href="#104">104</a>             }
<a name="105" href="#105">105</a>         }
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>         <strong>return</strong> table;
<a name="108" href="#108">108</a>     }
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>     <em>/**<em>*</em></em>
<a name="111" href="#111">111</a> <em>     * Remove a possible schema name from the table name.</em>
<a name="112" href="#112">112</a> <em>     *</em>
<a name="113" href="#113">113</a> <em>     * @param table The table name to use</em>
<a name="114" href="#114">114</a> <em>     *</em>
<a name="115" href="#115">115</a> <em>     * @return The table name with a possible schema name</em>
<a name="116" href="#116">116</a> <em>     *         stripped off</em>
<a name="117" href="#117">117</a> <em>     */</em>
<a name="118" href="#118">118</a>     <strong>public</strong> <strong>static</strong> String getUnqualifiedTableName(<strong>final</strong> String table)
<a name="119" href="#119">119</a>     {
<a name="120" href="#120">120</a>         <strong>if</strong> (table != <strong>null</strong>)
<a name="121" href="#121">121</a>         {
<a name="122" href="#122">122</a>             <strong>int</strong> dotIndex = table.lastIndexOf(<span class="string">"."</span>); <em class="comment">// Do we have a dot?</em>
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>             <strong>if</strong> (++dotIndex > 0) <em class="comment">// Incrementation allows for better test _and_ substring...</em>
<a name="125" href="#125">125</a>             {
<a name="126" href="#126">126</a>                 <strong>return</strong> table.substring(dotIndex);
<a name="127" href="#127">127</a>             }
<a name="128" href="#128">128</a>         }
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>         <strong>return</strong> table;
<a name="131" href="#131">131</a>     }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <em>/**<em>*</em></em>
<a name="134" href="#134">134</a> <em>     * Removes a possible function name or clause from a column name</em>
<a name="135" href="#135">135</a> <em>     *</em>
<a name="136" href="#136">136</a> <em>     * @param name The column name, possibly containing a clause</em>
<a name="137" href="#137">137</a> <em>     *</em>
<a name="138" href="#138">138</a> <em>     * @return The column name</em>
<a name="139" href="#139">139</a> <em>     *</em>
<a name="140" href="#140">140</a> <em>     * @throws TorqueException If the column name was malformed</em>
<a name="141" href="#141">141</a> <em>     */</em>
<a name="142" href="#142">142</a>     <strong>private</strong> <strong>static</strong> String removeSQLFunction(<strong>final</strong> String name)
<a name="143" href="#143">143</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="144" href="#144">144</a>     {
<a name="145" href="#145">145</a>         <em class="comment">// Empty name => return it</em>
<a name="146" href="#146">146</a>         <strong>if</strong> (StringUtils.isEmpty(name))
<a name="147" href="#147">147</a>         {
<a name="148" href="#148">148</a>             <strong>return</strong> name;
<a name="149" href="#149">149</a>         }
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>         <em class="comment">// Find Table.Column</em>
<a name="152" href="#152">152</a>         <strong>int</strong> dotIndex = name.indexOf('.');
<a name="153" href="#153">153</a>         <strong>if</strong> (dotIndex == -1)
<a name="154" href="#154">154</a>         {
<a name="155" href="#155">155</a>             dotIndex = name.indexOf(<span class="string">"*"</span>);
<a name="156" href="#156">156</a>         }
<a name="157" href="#157">157</a>         <strong>if</strong> (dotIndex == -1)
<a name="158" href="#158">158</a>         {
<a name="159" href="#159">159</a>             <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>(<span class="string">"removeSQLFunction() : Column name "</span>
<a name="160" href="#160">160</a>                     + name
<a name="161" href="#161">161</a>                     + <span class="string">" does not contain a . or a *"</span>);
<a name="162" href="#162">162</a>         }
<a name="163" href="#163">163</a>         String pre = name.substring(0, dotIndex);
<a name="164" href="#164">164</a>         String post = name.substring(dotIndex + 1, name.length());
<a name="165" href="#165">165</a>         <strong>int</strong> startIndex = StringUtils.lastIndexOfAny(pre, DELIMITERS);
<a name="166" href="#166">166</a>         <strong>int</strong> endIndex = StringUtils.indexOfAny(post, DELIMITERS);
<a name="167" href="#167">167</a>         <strong>if</strong> (startIndex &lt; 0 &amp;&amp; endIndex &lt; 0)
<a name="168" href="#168">168</a>         {
<a name="169" href="#169">169</a>             <strong>return</strong> name;
<a name="170" href="#170">170</a>         }
<a name="171" href="#171">171</a>         <strong>else</strong>
<a name="172" href="#172">172</a>         {
<a name="173" href="#173">173</a>             <strong>if</strong> (endIndex &lt; 0)
<a name="174" href="#174">174</a>             {
<a name="175" href="#175">175</a>                 endIndex = post.length();
<a name="176" href="#176">176</a>             }
<a name="177" href="#177">177</a>             <em class="comment">// if startIndex == -1 the formula is correct</em>
<a name="178" href="#178">178</a>             <strong>return</strong> name.substring(startIndex + 1, dotIndex + 1 + endIndex);
<a name="179" href="#179">179</a>         }
<a name="180" href="#180">180</a>     }
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>     <em>/**<em>*</em></em>
<a name="183" href="#183">183</a> <em>     * Returns a table name from an identifier. Each identifier is to be qualified</em>
<a name="184" href="#184">184</a> <em>     * as [schema.]table.column. This could also contain FUNCTION([schema.]table.column).</em>
<a name="185" href="#185">185</a> <em>     *</em>
<a name="186" href="#186">186</a> <em>     * @param name The (possible fully qualified) identifier name</em>
<a name="187" href="#187">187</a> <em>     *</em>
<a name="188" href="#188">188</a> <em>     * @return the fully qualified table name</em>
<a name="189" href="#189">189</a> <em>     *</em>
<a name="190" href="#190">190</a> <em>     * @throws TorqueException If the identifier name was malformed</em>
<a name="191" href="#191">191</a> <em>     */</em>
<a name="192" href="#192">192</a>     <strong>public</strong> <strong>static</strong> String getTableName(<strong>final</strong> String name, <strong>final</strong> String dbName)
<a name="193" href="#193">193</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="194" href="#194">194</a>     {
<a name="195" href="#195">195</a>         <strong>final</strong> String testName = removeSQLFunction(name);
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>         <strong>if</strong> (StringUtils.isEmpty(testName))
<a name="198" href="#198">198</a>         {
<a name="199" href="#199">199</a>             throwMalformedColumnNameException(
<a name="200" href="#200">200</a>                     <span class="string">"getTableName"</span>,
<a name="201" href="#201">201</a>                     name);
<a name="202" href="#202">202</a>         }
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a>         <em class="comment">// Everything before the last dot is the table name</em>
<a name="205" href="#205">205</a>         <strong>int</strong> rightDotIndex = testName.lastIndexOf('.');
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>         <strong>if</strong> (rightDotIndex &lt; 0)
<a name="208" href="#208">208</a>         {
<a name="209" href="#209">209</a>             <strong>if</strong> (<span class="string">"*"</span>.equals(testName))
<a name="210" href="#210">210</a>             {
<a name="211" href="#211">211</a>                 <strong>return</strong> <strong>null</strong>;
<a name="212" href="#212">212</a>             }
<a name="213" href="#213">213</a> 
<a name="214" href="#214">214</a>             throwMalformedColumnNameException(
<a name="215" href="#215">215</a>                     <span class="string">"getTableName"</span>,
<a name="216" href="#216">216</a>                     name);
<a name="217" href="#217">217</a>         }
<a name="218" href="#218">218</a> 
<a name="219" href="#219">219</a>         <strong>return</strong> getFullTableName(testName.substring(0, rightDotIndex), dbName);
<a name="220" href="#220">220</a>     }
<a name="221" href="#221">221</a> 
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a> 
<a name="224" href="#224">224</a>     <em>/**<em>*</em></em>
<a name="225" href="#225">225</a> <em>     * Returns a set of all tables and possible aliases referenced</em>
<a name="226" href="#226">226</a> <em>     * from a criterion. The resulting Set can be directly used to</em>
<a name="227" href="#227">227</a> <em>     * build a WHERE clause</em>
<a name="228" href="#228">228</a> <em>     *</em>
<a name="229" href="#229">229</a> <em>     * @param crit A Criteria object</em>
<a name="230" href="#230">230</a> <em>     * @param tableCallback A Callback Object</em>
<a name="231" href="#231">231</a> <em>     * @return A Set of tables.</em>
<a name="232" href="#232">232</a> <em>     */</em>
<a name="233" href="#233">233</a>     <strong>public</strong> <strong>static</strong> Set getTableSet(
<a name="234" href="#234">234</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="235" href="#235">235</a>             <strong>final</strong> TableCallback tableCallback)
<a name="236" href="#236">236</a>     {
<a name="237" href="#237">237</a>         HashSet tables = <strong>new</strong> HashSet();
<a name="238" href="#238">238</a> 
<a name="239" href="#239">239</a>         <em class="comment">// Loop over all the Criterions</em>
<a name="240" href="#240">240</a>         <strong>for</strong> (Iterator it = crit.keySet().iterator(); it.hasNext();)
<a name="241" href="#241">241</a>         {
<a name="242" href="#242">242</a>             String key = (String) it.next();
<a name="243" href="#243">243</a>             Criteria.Criterion c = crit.getCriterion(key);
<a name="244" href="#244">244</a>             List tableNames = c.getAllTables();
<a name="245" href="#245">245</a> 
<a name="246" href="#246">246</a>             <em class="comment">// Loop over all Tables referenced in this criterion.</em>
<a name="247" href="#247">247</a>             <strong>for</strong> (Iterator it2 = tableNames.iterator(); it2.hasNext();)
<a name="248" href="#248">248</a>             {
<a name="249" href="#249">249</a>                 String name = (String) it2.next();
<a name="250" href="#250">250</a>                 String aliasName = crit.getTableForAlias(name);
<a name="251" href="#251">251</a> 
<a name="252" href="#252">252</a>                 <em class="comment">// If the tables have an alias, add an "&lt;xxx> AS &lt;yyy> statement"</em>
<a name="253" href="#253">253</a>                 <strong>if</strong> (StringUtils.isNotEmpty(aliasName))
<a name="254" href="#254">254</a>                 {
<a name="255" href="#255">255</a>                     String newName =
<a name="256" href="#256">256</a>                             <strong>new</strong> StringBuffer(name.length() + aliasName.length() + 4)
<a name="257" href="#257">257</a>                             .append(aliasName)
<a name="258" href="#258">258</a>                             .append(<span class="string">" AS "</span>)
<a name="259" href="#259">259</a>                             .append(name)
<a name="260" href="#260">260</a>                             .toString();
<a name="261" href="#261">261</a>                     name = newName;
<a name="262" href="#262">262</a>                 }
<a name="263" href="#263">263</a>                 tables.add(name);
<a name="264" href="#264">264</a>             }
<a name="265" href="#265">265</a> 
<a name="266" href="#266">266</a>             <strong>if</strong> (tableCallback != <strong>null</strong>)
<a name="267" href="#267">267</a>             {
<a name="268" href="#268">268</a>                 tableCallback.process(tables, key, crit);
<a name="269" href="#269">269</a>             }
<a name="270" href="#270">270</a>         }
<a name="271" href="#271">271</a> 
<a name="272" href="#272">272</a>         <strong>return</strong> tables;
<a name="273" href="#273">273</a>     }
<a name="274" href="#274">274</a> 
<a name="275" href="#275">275</a>     <em>/**<em>*</em></em>
<a name="276" href="#276">276</a> <em>     * Builds a Query clause for Updating and deleting</em>
<a name="277" href="#277">277</a> <em>     *</em>
<a name="278" href="#278">278</a> <em>     * @param crit a &lt;code>Criteria&lt;/code> value</em>
<a name="279" href="#279">279</a> <em>     * @param params a &lt;code>List&lt;/code> value</em>
<a name="280" href="#280">280</a> <em>     * @param qc a &lt;code>QueryCallback&lt;/code> value</em>
<a name="281" href="#281">281</a> <em>     * @return a &lt;code>Query&lt;/code> value</em>
<a name="282" href="#282">282</a> <em>     * @exception TorqueException if an error occurs</em>
<a name="283" href="#283">283</a> <em>     */</em>
<a name="284" href="#284">284</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> buildQueryClause(<strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="285" href="#285">285</a>             <strong>final</strong> List params,
<a name="286" href="#286">286</a>             <strong>final</strong> QueryCallback qc)
<a name="287" href="#287">287</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="288" href="#288">288</a>     {
<a name="289" href="#289">289</a>         <a href="../../../../org/apache/torque/util/Query.html">Query</a> query = <strong>new</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a>();
<a name="290" href="#290">290</a> 
<a name="291" href="#291">291</a>         <strong>final</strong> String dbName = crit.getDbName();
<a name="292" href="#292">292</a>         <strong>final</strong> <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db = Torque.getDB(dbName);
<a name="293" href="#293">293</a>         <strong>final</strong> <a href="../../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a> dbMap = Torque.getDatabaseMap(dbName);
<a name="294" href="#294">294</a> 
<a name="295" href="#295">295</a>         JoinBuilder.processJoins(db, dbMap, crit, query);
<a name="296" href="#296">296</a>         processModifiers(crit, query);
<a name="297" href="#297">297</a>         processSelectColumns(crit, query, dbName);
<a name="298" href="#298">298</a>         processAsColumns(crit, query);
<a name="299" href="#299">299</a>         processCriterions(db, dbMap, dbName, crit, query,  params, qc);
<a name="300" href="#300">300</a>         processGroupBy(crit, query);
<a name="301" href="#301">301</a>         processHaving(crit, query);
<a name="302" href="#302">302</a>         processOrderBy(db, dbMap, crit, query);
<a name="303" href="#303">303</a>         processLimits(crit, query);
<a name="304" href="#304">304</a> 
<a name="305" href="#305">305</a>         <strong>if</strong> (log.isDebugEnabled())
<a name="306" href="#306">306</a>         {
<a name="307" href="#307">307</a>             log.debug(query.toString());
<a name="308" href="#308">308</a>         }
<a name="309" href="#309">309</a>         <strong>return</strong> query;
<a name="310" href="#310">310</a>     }
<a name="311" href="#311">311</a> 
<a name="312" href="#312">312</a> 
<a name="313" href="#313">313</a>     <em>/**<em>*</em></em>
<a name="314" href="#314">314</a> <em>     * adds the select columns from the criteria to the query</em>
<a name="315" href="#315">315</a> <em>     * @param criteria the criteria from which the select columns are taken</em>
<a name="316" href="#316">316</a> <em>     * @param query the query to which the select columns should be added</em>
<a name="317" href="#317">317</a> <em>     * @throws TorqueException if the select columns can not be processed</em>
<a name="318" href="#318">318</a> <em>     */</em>
<a name="319" href="#319">319</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processSelectColumns(
<a name="320" href="#320">320</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> criteria,
<a name="321" href="#321">321</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query,
<a name="322" href="#322">322</a>             <strong>final</strong> String dbName)
<a name="323" href="#323">323</a>         throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="324" href="#324">324</a>     {
<a name="325" href="#325">325</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> selectClause = query.getSelectClause();
<a name="326" href="#326">326</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> select = criteria.getSelectColumns();
<a name="327" href="#327">327</a> 
<a name="328" href="#328">328</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; select.size(); i++)
<a name="329" href="#329">329</a>         {
<a name="330" href="#330">330</a>             String identifier = (String) select.get(i);
<a name="331" href="#331">331</a>             selectClause.add(identifier);
<a name="332" href="#332">332</a>             addTableToFromClause(getTableName(identifier, dbName), criteria, query);
<a name="333" href="#333">333</a>         }
<a name="334" href="#334">334</a>     }
<a name="335" href="#335">335</a> 
<a name="336" href="#336">336</a>     <em>/**<em>*</em></em>
<a name="337" href="#337">337</a> <em>     * adds the As-columns from the criteria to the query.</em>
<a name="338" href="#338">338</a> <em>     * @param criteria the criteria from which the As-columns are taken</em>
<a name="339" href="#339">339</a> <em>     * @param query the query to which the As-columns should be added</em>
<a name="340" href="#340">340</a> <em>     */</em>
<a name="341" href="#341">341</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processAsColumns(
<a name="342" href="#342">342</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> criteria,
<a name="343" href="#343">343</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query)
<a name="344" href="#344">344</a>     {
<a name="345" href="#345">345</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> querySelectClause = query.getSelectClause();
<a name="346" href="#346">346</a>         Map criteriaAsColumns = criteria.getAsColumns();
<a name="347" href="#347">347</a> 
<a name="348" href="#348">348</a>         <strong>for</strong> (Iterator it = criteriaAsColumns.entrySet().iterator(); it.hasNext();)
<a name="349" href="#349">349</a>         {
<a name="350" href="#350">350</a>             Map.Entry entry = (Map.Entry) it.next();
<a name="351" href="#351">351</a>             String key = (String) entry.getKey();
<a name="352" href="#352">352</a>             querySelectClause.add(
<a name="353" href="#353">353</a>                     <strong>new</strong> StringBuffer()
<a name="354" href="#354">354</a>                     .append(entry.getValue())
<a name="355" href="#355">355</a>                     .append(SqlEnum.AS)
<a name="356" href="#356">356</a>                     .append(key)
<a name="357" href="#357">357</a>                     .toString());
<a name="358" href="#358">358</a>         }
<a name="359" href="#359">359</a>     }
<a name="360" href="#360">360</a> 
<a name="361" href="#361">361</a>     <em>/**<em>*</em></em>
<a name="362" href="#362">362</a> <em>     * adds the Modifiers from the criteria to the query</em>
<a name="363" href="#363">363</a> <em>     * @param criteria the criteria from which the Modifiers are taken</em>
<a name="364" href="#364">364</a> <em>     * @param query the query to which the Modifiers should be added</em>
<a name="365" href="#365">365</a> <em>     */</em>
<a name="366" href="#366">366</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processModifiers(
<a name="367" href="#367">367</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> criteria,
<a name="368" href="#368">368</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query)
<a name="369" href="#369">369</a>     {
<a name="370" href="#370">370</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> selectModifiers = query.getSelectModifiers();
<a name="371" href="#371">371</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> modifiers = criteria.getSelectModifiers();
<a name="372" href="#372">372</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; modifiers.size(); i++)
<a name="373" href="#373">373</a>         {
<a name="374" href="#374">374</a>             selectModifiers.add(modifiers.get(i));
<a name="375" href="#375">375</a>         }
<a name="376" href="#376">376</a>     }
<a name="377" href="#377">377</a> 
<a name="378" href="#378">378</a>     <em>/**<em>*</em></em>
<a name="379" href="#379">379</a> <em>     * adds the Criterion-objects from the criteria to the query</em>
<a name="380" href="#380">380</a> <em>     * @param criteria the criteria from which the Criterion-objects are taken</em>
<a name="381" href="#381">381</a> <em>     * @param query the query to which the Criterion-objects should be added</em>
<a name="382" href="#382">382</a> <em>     * @param params the parameters if a prepared statement should be built,</em>
<a name="383" href="#383">383</a> <em>     *        or null if a normal statement should be built.</em>
<a name="384" href="#384">384</a> <em>     * @throws TorqueException if the Criterion-objects can not be processed</em>
<a name="385" href="#385">385</a> <em>     */</em>
<a name="386" href="#386">386</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processCriterions(
<a name="387" href="#387">387</a>             <strong>final</strong> <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db,
<a name="388" href="#388">388</a>             <strong>final</strong> <a href="../../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a> dbMap,
<a name="389" href="#389">389</a>             <strong>final</strong> String dbName,
<a name="390" href="#390">390</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="391" href="#391">391</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query,
<a name="392" href="#392">392</a>             <strong>final</strong> List params,
<a name="393" href="#393">393</a>             <strong>final</strong> QueryCallback qc)
<a name="394" href="#394">394</a>         throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="395" href="#395">395</a>     {
<a name="396" href="#396">396</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> whereClause = query.getWhereClause();
<a name="397" href="#397">397</a> 
<a name="398" href="#398">398</a>         <strong>for</strong> (Iterator it = crit.keySet().iterator(); it.hasNext();)
<a name="399" href="#399">399</a>         {
<a name="400" href="#400">400</a>             String key = (String) it.next();
<a name="401" href="#401">401</a>             Criteria.Criterion criterion = crit.getCriterion(key);
<a name="402" href="#402">402</a>             Criteria.Criterion[] someCriteria =
<a name="403" href="#403">403</a>                     criterion.getAttachedCriterion();
<a name="404" href="#404">404</a> 
<a name="405" href="#405">405</a>             String table = <strong>null</strong>;
<a name="406" href="#406">406</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; someCriteria.length; i++)
<a name="407" href="#407">407</a>             {
<a name="408" href="#408">408</a>                 String tableName = someCriteria[i].getTable();
<a name="409" href="#409">409</a> 
<a name="410" href="#410">410</a>                 <em class="comment">// add the table to the from clause, if it is not already</em>
<a name="411" href="#411">411</a>                 <em class="comment">// contained there</em>
<a name="412" href="#412">412</a>                 <em class="comment">// it is important that this piece of code is executed AFTER</em>
<a name="413" href="#413">413</a>                 <em class="comment">// the joins are processed</em>
<a name="414" href="#414">414</a>                 addTableToFromClause(getFullTableName(tableName, dbName), crit, query);
<a name="415" href="#415">415</a> 
<a name="416" href="#416">416</a>                 table = crit.getTableForAlias(tableName);
<a name="417" href="#417">417</a>                 <strong>if</strong> (table == <strong>null</strong>)
<a name="418" href="#418">418</a>                 {
<a name="419" href="#419">419</a>                     table = tableName;
<a name="420" href="#420">420</a>                 }
<a name="421" href="#421">421</a> 
<a name="422" href="#422">422</a>                 <strong>boolean</strong> ignoreCase =  ((crit.isIgnoreCase() || someCriteria[i].isIgnoreCase())
<a name="423" href="#423">423</a>                         &amp;&amp; (dbMap.getTable(table)
<a name="424" href="#424">424</a>                                 .getColumn(someCriteria[i].getColumn())
<a name="425" href="#425">425</a>                                 .getType()
<a name="426" href="#426">426</a>                                 instanceof String));
<a name="427" href="#427">427</a> 
<a name="428" href="#428">428</a>                 someCriteria[i].setIgnoreCase(ignoreCase);
<a name="429" href="#429">429</a>             }
<a name="430" href="#430">430</a> 
<a name="431" href="#431">431</a>             criterion.setDB(db);
<a name="432" href="#432">432</a>             whereClause.add(qc.process(criterion, params));
<a name="433" href="#433">433</a>         }
<a name="434" href="#434">434</a>     }
<a name="435" href="#435">435</a> 
<a name="436" href="#436">436</a>     <em>/**<em>*</em></em>
<a name="437" href="#437">437</a> <em>     * adds the OrderBy-Columns from the criteria to the query</em>
<a name="438" href="#438">438</a> <em>     * @param criteria the criteria from which the OrderBy-Columns are taken</em>
<a name="439" href="#439">439</a> <em>     * @param query the query to which the OrderBy-Columns should be added</em>
<a name="440" href="#440">440</a> <em>     * @throws TorqueException if the OrderBy-Columns can not be processed</em>
<a name="441" href="#441">441</a> <em>     */</em>
<a name="442" href="#442">442</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processOrderBy(
<a name="443" href="#443">443</a>             <strong>final</strong> <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db,
<a name="444" href="#444">444</a>             <strong>final</strong> <a href="../../../../org/apache/torque/map/DatabaseMap.html">DatabaseMap</a> dbMap,
<a name="445" href="#445">445</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="446" href="#446">446</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query)
<a name="447" href="#447">447</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="448" href="#448">448</a>     {
<a name="449" href="#449">449</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> orderByClause = query.getOrderByClause();
<a name="450" href="#450">450</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> selectClause = query.getSelectClause();
<a name="451" href="#451">451</a> 
<a name="452" href="#452">452</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> orderBy = crit.getOrderByColumns();
<a name="453" href="#453">453</a> 
<a name="454" href="#454">454</a>         <strong>if</strong> (orderBy != <strong>null</strong> &amp;&amp; orderBy.size() > 0)
<a name="455" href="#455">455</a>         {
<a name="456" href="#456">456</a>             <em class="comment">// Check for each String/Character column and apply</em>
<a name="457" href="#457">457</a>             <em class="comment">// toUpperCase().</em>
<a name="458" href="#458">458</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; orderBy.size(); i++)
<a name="459" href="#459">459</a>             {
<a name="460" href="#460">460</a>                 String orderByColumn = (String) orderBy.get(i);
<a name="461" href="#461">461</a> 
<a name="462" href="#462">462</a>                 String strippedColumnName
<a name="463" href="#463">463</a>                         = removeSQLFunction(orderByColumn);
<a name="464" href="#464">464</a>                 <strong>int</strong> dotPos = strippedColumnName.lastIndexOf('.');
<a name="465" href="#465">465</a>                 <strong>if</strong> (dotPos == -1)
<a name="466" href="#466">466</a>                 {
<a name="467" href="#467">467</a>                     <em class="comment">// We are not able to look up the table in the</em>
<a name="468" href="#468">468</a>                     <em class="comment">// tableMap, as no table name is given. Simply add</em>
<a name="469" href="#469">469</a>                     <em class="comment">// the orderBy and hope the user knows what he is</em>
<a name="470" href="#470">470</a>                     <em class="comment">// doing.</em>
<a name="471" href="#471">471</a>                     orderByClause.add(orderByColumn);
<a name="472" href="#472">472</a>                     <strong>continue</strong>;
<a name="473" href="#473">473</a>                 }
<a name="474" href="#474">474</a> 
<a name="475" href="#475">475</a>                 String tableName = strippedColumnName.substring(0, dotPos);
<a name="476" href="#476">476</a>                 String table = crit.getTableForAlias(tableName);
<a name="477" href="#477">477</a>                 <strong>if</strong> (table == <strong>null</strong>)
<a name="478" href="#478">478</a>                 {
<a name="479" href="#479">479</a>                     table = tableName;
<a name="480" href="#480">480</a>                 }
<a name="481" href="#481">481</a> 
<a name="482" href="#482">482</a>                 <em class="comment">// See if there's a space (between the column list and sort</em>
<a name="483" href="#483">483</a>                 <em class="comment">// order in ORDER BY table.column DESC).</em>
<a name="484" href="#484">484</a>                 <strong>int</strong> spacePos = strippedColumnName.indexOf(' ');
<a name="485" href="#485">485</a>                 String columnName;
<a name="486" href="#486">486</a>                 <strong>if</strong> (spacePos == -1)
<a name="487" href="#487">487</a>                 {
<a name="488" href="#488">488</a>                     columnName =
<a name="489" href="#489">489</a>                             strippedColumnName.substring(dotPos + 1);
<a name="490" href="#490">490</a>                 }
<a name="491" href="#491">491</a>                 <strong>else</strong>
<a name="492" href="#492">492</a>                 {
<a name="493" href="#493">493</a>                     columnName = strippedColumnName.substring(
<a name="494" href="#494">494</a>                             dotPos + 1,
<a name="495" href="#495">495</a>                             spacePos);
<a name="496" href="#496">496</a>                 }
<a name="497" href="#497">497</a>                 <a href="../../../../org/apache/torque/map/ColumnMap.html">ColumnMap</a> column = dbMap.getTable(table).getColumn(columnName);
<a name="498" href="#498">498</a> 
<a name="499" href="#499">499</a>                 <em class="comment">// only ignore case in order by for string columns</em>
<a name="500" href="#500">500</a>                 <em class="comment">// which do not have a function around them</em>
<a name="501" href="#501">501</a>                 <strong>if</strong> (column.getType() instanceof String
<a name="502" href="#502">502</a>                         &amp;&amp; orderByColumn.indexOf('(') == -1)
<a name="503" href="#503">503</a>                 {
<a name="504" href="#504">504</a>                     <em class="comment">// find space pos relative to orderByColumn</em>
<a name="505" href="#505">505</a>                     spacePos = orderByColumn.indexOf(' ');
<a name="506" href="#506">506</a>                     <strong>if</strong> (spacePos == -1)
<a name="507" href="#507">507</a>                     {
<a name="508" href="#508">508</a>                         orderByClause.add(
<a name="509" href="#509">509</a>                                 db.ignoreCaseInOrderBy(orderByColumn));
<a name="510" href="#510">510</a>                     }
<a name="511" href="#511">511</a>                     <strong>else</strong>
<a name="512" href="#512">512</a>                     {
<a name="513" href="#513">513</a>                         orderByClause.add(
<a name="514" href="#514">514</a>                                 db.ignoreCaseInOrderBy(
<a name="515" href="#515">515</a>                                         orderByColumn.substring(0, spacePos))
<a name="516" href="#516">516</a>                                 + orderByColumn.substring(spacePos));
<a name="517" href="#517">517</a>                     }
<a name="518" href="#518">518</a>                     selectClause.add(
<a name="519" href="#519">519</a>                             db.ignoreCaseInOrderBy(tableName + '.' + columnName));
<a name="520" href="#520">520</a>                 }
<a name="521" href="#521">521</a>                 <strong>else</strong>
<a name="522" href="#522">522</a>                 {
<a name="523" href="#523">523</a>                     orderByClause.add(orderByColumn);
<a name="524" href="#524">524</a>                 }
<a name="525" href="#525">525</a>             }
<a name="526" href="#526">526</a>         }
<a name="527" href="#527">527</a>     }
<a name="528" href="#528">528</a> 
<a name="529" href="#529">529</a>     <em>/**<em>*</em></em>
<a name="530" href="#530">530</a> <em>     * adds the GroupBy-Columns from the criteria to the query</em>
<a name="531" href="#531">531</a> <em>     * @param criteria the criteria from which the GroupBy-Columns are taken</em>
<a name="532" href="#532">532</a> <em>     * @param query the query to which the GroupBy-Columns should be added</em>
<a name="533" href="#533">533</a> <em>     * @throws TorqueException if the GroupBy-Columns can not be processed</em>
<a name="534" href="#534">534</a> <em>     */</em>
<a name="535" href="#535">535</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processGroupBy(
<a name="536" href="#536">536</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="537" href="#537">537</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query)
<a name="538" href="#538">538</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="539" href="#539">539</a>     {
<a name="540" href="#540">540</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> groupByClause = query.getGroupByClause();
<a name="541" href="#541">541</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> groupBy = crit.getGroupByColumns();
<a name="542" href="#542">542</a> 
<a name="543" href="#543">543</a>         <em class="comment">// need to allow for multiple group bys</em>
<a name="544" href="#544">544</a>         <strong>if</strong> (groupBy != <strong>null</strong>)
<a name="545" href="#545">545</a>         {
<a name="546" href="#546">546</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; groupBy.size(); i++)
<a name="547" href="#547">547</a>             {
<a name="548" href="#548">548</a>                 String columnName = (String) groupBy.get(i);
<a name="549" href="#549">549</a>                 String column = (String) crit.getAsColumns().get(columnName);
<a name="550" href="#550">550</a> 
<a name="551" href="#551">551</a>                 <strong>if</strong> (column == <strong>null</strong>)
<a name="552" href="#552">552</a>                 {
<a name="553" href="#553">553</a>                     column = columnName;
<a name="554" href="#554">554</a>                 }
<a name="555" href="#555">555</a> 
<a name="556" href="#556">556</a>                 <strong>if</strong> (column.indexOf('.') != -1)
<a name="557" href="#557">557</a>                 {
<a name="558" href="#558">558</a>                     groupByClause.add(column);
<a name="559" href="#559">559</a>                 }
<a name="560" href="#560">560</a>                 <strong>else</strong>
<a name="561" href="#561">561</a>                 {
<a name="562" href="#562">562</a>                     throwMalformedColumnNameException(<span class="string">"group by"</span>,
<a name="563" href="#563">563</a>                             column);
<a name="564" href="#564">564</a>                 }
<a name="565" href="#565">565</a>             }
<a name="566" href="#566">566</a>         }
<a name="567" href="#567">567</a>     }
<a name="568" href="#568">568</a> 
<a name="569" href="#569">569</a>     <em>/**<em>*</em></em>
<a name="570" href="#570">570</a> <em>     * adds the Having-Columns from the criteria to the query</em>
<a name="571" href="#571">571</a> <em>     * @param criteria the criteria from which the Having-Columns are taken</em>
<a name="572" href="#572">572</a> <em>     * @param query the query to which the Having-Columns should be added</em>
<a name="573" href="#573">573</a> <em>     * @throws TorqueException if the Having-Columns can not be processed</em>
<a name="574" href="#574">574</a> <em>     */</em>
<a name="575" href="#575">575</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processHaving(
<a name="576" href="#576">576</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="577" href="#577">577</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query)
<a name="578" href="#578">578</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="579" href="#579">579</a>     {
<a name="580" href="#580">580</a>         Criteria.Criterion having = crit.getHaving();
<a name="581" href="#581">581</a>         <strong>if</strong> (having != <strong>null</strong>)
<a name="582" href="#582">582</a>         {
<a name="583" href="#583">583</a>             <em class="comment">//String groupByString = null;</em>
<a name="584" href="#584">584</a>             query.setHaving(having.toString());
<a name="585" href="#585">585</a>         }
<a name="586" href="#586">586</a>     }
<a name="587" href="#587">587</a> 
<a name="588" href="#588">588</a>     <em>/**<em>*</em></em>
<a name="589" href="#589">589</a> <em>     * adds a Limit clause to the query if supported by the database</em>
<a name="590" href="#590">590</a> <em>     * @param criteria the criteria from which the Limit and Offset values</em>
<a name="591" href="#591">591</a> <em>     *        are taken</em>
<a name="592" href="#592">592</a> <em>     * @param query the query to which the Limit clause should be added</em>
<a name="593" href="#593">593</a> <em>     * @throws TorqueException if the Database adapter cannot be obtained</em>
<a name="594" href="#594">594</a> <em>     */</em>
<a name="595" href="#595">595</a>     <strong>private</strong> <strong>static</strong> <strong>void</strong> processLimits(
<a name="596" href="#596">596</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit,
<a name="597" href="#597">597</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Query.html">Query</a> query)
<a name="598" href="#598">598</a>             throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="599" href="#599">599</a>     {
<a name="600" href="#600">600</a>         <strong>int</strong> limit = crit.getLimit();
<a name="601" href="#601">601</a>         <strong>int</strong> offset = crit.getOffset();
<a name="602" href="#602">602</a> 
<a name="603" href="#603">603</a>         <strong>if</strong> (offset > 0 || limit >= 0)
<a name="604" href="#604">604</a>         {
<a name="605" href="#605">605</a>             <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> db = Torque.getDB(crit.getDbName());
<a name="606" href="#606">606</a>             db.generateLimits(query, offset, limit);
<a name="607" href="#607">607</a>         }
<a name="608" href="#608">608</a>     }
<a name="609" href="#609">609</a> 
<a name="610" href="#610">610</a>     <em>/**<em>*</em></em>
<a name="611" href="#611">611</a> <em>     * Throws a TorqueException with the malformed column name error</em>
<a name="612" href="#612">612</a> <em>     * message.  The error message looks like this:&lt;p></em>
<a name="613" href="#613">613</a> <em>     *</em>
<a name="614" href="#614">614</a> <em>     * &lt;code></em>
<a name="615" href="#615">615</a> <em>     *     Malformed column name in Criteria [criteriaPhrase]:</em>
<a name="616" href="#616">616</a> <em>     *     '[columnName]' is not of the form 'table.column'</em>
<a name="617" href="#617">617</a> <em>     * &lt;/code></em>
<a name="618" href="#618">618</a> <em>     *</em>
<a name="619" href="#619">619</a> <em>     * @param criteriaPhrase a String, one of "select", "join", or "order by"</em>
<a name="620" href="#620">620</a> <em>     * @param columnName a String containing the offending column name</em>
<a name="621" href="#621">621</a> <em>     * @throws TorqueException Any exceptions caught during processing will be</em>
<a name="622" href="#622">622</a> <em>     *         rethrown wrapped into a TorqueException.</em>
<a name="623" href="#623">623</a> <em>     */</em>
<a name="624" href="#624">624</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> throwMalformedColumnNameException(
<a name="625" href="#625">625</a>         <strong>final</strong> String criteriaPhrase,
<a name="626" href="#626">626</a>         <strong>final</strong> String columnName)
<a name="627" href="#627">627</a>         throws <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>
<a name="628" href="#628">628</a>     {
<a name="629" href="#629">629</a>         StringBuffer sb = <strong>new</strong> StringBuffer()
<a name="630" href="#630">630</a>                 .append(<span class="string">"Malformed column name in Criteria "</span>)
<a name="631" href="#631">631</a>                 .append(criteriaPhrase)
<a name="632" href="#632">632</a>                 .append(<span class="string">": '"</span>)
<a name="633" href="#633">633</a>                 .append(StringUtils.isEmpty(columnName) ? <span class="string">"&lt;empty>"</span> : columnName)
<a name="634" href="#634">634</a>                 .append(<span class="string">"' is not of the form 'table.column'"</span>);
<a name="635" href="#635">635</a> 
<a name="636" href="#636">636</a>         <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/torque/TorqueException.html">TorqueException</a>(sb.toString());
<a name="637" href="#637">637</a>     }
<a name="638" href="#638">638</a> 
<a name="639" href="#639">639</a>     <em>/**<em>*</em></em>
<a name="640" href="#640">640</a> <em>     * Returns the tablename which can be added to a From Clause.</em>
<a name="641" href="#641">641</a> <em>     * This takes care of any aliases that might be defined.</em>
<a name="642" href="#642">642</a> <em>     * For example, if an alias "a" for the table AUTHOR is defined</em>
<a name="643" href="#643">643</a> <em>     * in the Criteria criteria, getTableNameForFromClause("a", criteria)</em>
<a name="644" href="#644">644</a> <em>     * returns "AUTHOR a".</em>
<a name="645" href="#645">645</a> <em>     * @param tableName the name of a table</em>
<a name="646" href="#646">646</a> <em>     *        or the alias for a table</em>
<a name="647" href="#647">647</a> <em>     * @param criteria a criteria object to resolve a possible alias</em>
<a name="648" href="#648">648</a> <em>     * @return either the tablename itself if tableOrAliasName is not an alias,</em>
<a name="649" href="#649">649</a> <em>     *         or a String of the form "tableName tableOrAliasName"</em>
<a name="650" href="#650">650</a> <em>     *         if tableOrAliasName is an alias for a table name</em>
<a name="651" href="#651">651</a> <em>     */</em>
<a name="652" href="#652">652</a>     <strong>public</strong> <strong>static</strong> String getTableNameForFromClause(
<a name="653" href="#653">653</a>             <strong>final</strong> String tableName,
<a name="654" href="#654">654</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> criteria)
<a name="655" href="#655">655</a>     {
<a name="656" href="#656">656</a>         String shortTableName = getUnqualifiedTableName(tableName);
<a name="657" href="#657">657</a> 
<a name="658" href="#658">658</a>         <em class="comment">// Most of the time, the alias would be for the short name...</em>
<a name="659" href="#659">659</a>         String aliasName = criteria.getTableForAlias(shortTableName);
<a name="660" href="#660">660</a>         <strong>if</strong> (StringUtils.isEmpty(aliasName))
<a name="661" href="#661">661</a>         {
<a name="662" href="#662">662</a>             <em class="comment">// But we should also check the FQN...</em>
<a name="663" href="#663">663</a>             aliasName = criteria.getTableForAlias(tableName);
<a name="664" href="#664">664</a>         }
<a name="665" href="#665">665</a> 
<a name="666" href="#666">666</a>         <strong>if</strong> (StringUtils.isNotEmpty(aliasName))
<a name="667" href="#667">667</a>         {
<a name="668" href="#668">668</a>             <em class="comment">// If the tables have an alias, add an "&lt;xxx> &lt;yyy> statement"</em>
<a name="669" href="#669">669</a>             <em class="comment">// &lt;xxx> AS &lt;yyy> causes problems on oracle</em>
<a name="670" href="#670">670</a>             <strong>return</strong> <strong>new</strong> StringBuffer(
<a name="671" href="#671">671</a>                     tableName.length() + aliasName.length() + 1)
<a name="672" href="#672">672</a>                     .append(aliasName)
<a name="673" href="#673">673</a>                     .append(<span class="string">" "</span>)
<a name="674" href="#674">674</a>                     .append(tableName)
<a name="675" href="#675">675</a>                     .toString();
<a name="676" href="#676">676</a>         }
<a name="677" href="#677">677</a> 
<a name="678" href="#678">678</a>         <strong>return</strong> tableName;
<a name="679" href="#679">679</a>     }
<a name="680" href="#680">680</a> 
<a name="681" href="#681">681</a>     <em>/**<em>*</em></em>
<a name="682" href="#682">682</a> <em>     * Checks if the Tablename tableName is already contained in a from clause.</em>
<a name="683" href="#683">683</a> <em>     * If tableName and the tablenames in fromClause are generated by</em>
<a name="684" href="#684">684</a> <em>     * getTablenameForFromClause(String, Criteria), (which they usually are),</em>
<a name="685" href="#685">685</a> <em>     * then different aliases for the same table are treated</em>
<a name="686" href="#686">686</a> <em>     * as different tables: E.g.</em>
<a name="687" href="#687">687</a> <em>     * fromClauseContainsTableName(fromClause, "table_a a") returns false if</em>
<a name="688" href="#688">688</a> <em>     * fromClause contains only another alias for table_a ,</em>
<a name="689" href="#689">689</a> <em>     * e.g. "table_a aa" and the unaliased tablename "table_a".</em>
<a name="690" href="#690">690</a> <em>     * Special case: If tableName is null, true is returned.</em>
<a name="691" href="#691">691</a> <em>     * @param fromClause a list containing only elements of type.</em>
<a name="692" href="#692">692</a> <em>     *        Query.FromElement</em>
<a name="693" href="#693">693</a> <em>     * @param tableName the tablename to check</em>
<a name="694" href="#694">694</a> <em>     * @return if the Tablename tableName is already contained in a from clause.</em>
<a name="695" href="#695">695</a> <em>     *         If tableName is null, true is returned.</em>
<a name="696" href="#696">696</a> <em>     */</em>
<a name="697" href="#697">697</a>     <strong>public</strong> <strong>static</strong> <strong>boolean</strong> fromClauseContainsTableName(
<a name="698" href="#698">698</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> fromClause,
<a name="699" href="#699">699</a>             <strong>final</strong> String tableName)
<a name="700" href="#700">700</a>     {
<a name="701" href="#701">701</a>         <strong>if</strong> (tableName == <strong>null</strong>)
<a name="702" href="#702">702</a>         {
<a name="703" href="#703">703</a>             <em class="comment">// usually this function is called to see if tableName should be</em>
<a name="704" href="#704">704</a>             <em class="comment">// added to the fromClause. As null should not be added,</em>
<a name="705" href="#705">705</a>             <em class="comment">// true is returned.</em>
<a name="706" href="#706">706</a>             <strong>return</strong> <strong>true</strong>;
<a name="707" href="#707">707</a>         }
<a name="708" href="#708">708</a>         <strong>for</strong> (Iterator it = fromClause.iterator(); it.hasNext();)
<a name="709" href="#709">709</a>         {
<a name="710" href="#710">710</a>             Query.FromElement fromElement
<a name="711" href="#711">711</a>                     = (Query.FromElement) it.next();
<a name="712" href="#712">712</a>             <strong>if</strong> (tableName.equals(fromElement.getTableName()))
<a name="713" href="#713">713</a>             {
<a name="714" href="#714">714</a>                 <strong>return</strong> <strong>true</strong>;
<a name="715" href="#715">715</a>             }
<a name="716" href="#716">716</a>         }
<a name="717" href="#717">717</a>         <strong>return</strong> false;
<a name="718" href="#718">718</a>     }
<a name="719" href="#719">719</a> 
<a name="720" href="#720">720</a>     <em>/**<em>*</em></em>
<a name="721" href="#721">721</a> <em>     * adds a table to the from clause of a query, if it is not already</em>
<a name="722" href="#722">722</a> <em>     * contained there.</em>
<a name="723" href="#723">723</a> <em>     * @param tableOrAliasName the name of a table</em>
<a name="724" href="#724">724</a> <em>     *        or the alias for a table</em>
<a name="725" href="#725">725</a> <em>     * @param criteria a criteria object to resolve a possible alias</em>
<a name="726" href="#726">726</a> <em>     * @param query the query where the the tablename should be added</em>
<a name="727" href="#727">727</a> <em>     *        to the from clause</em>
<a name="728" href="#728">728</a> <em>     * @return the table in the from clause which represents the</em>
<a name="729" href="#729">729</a> <em>     *         supplied tableOrAliasName</em>
<a name="730" href="#730">730</a> <em>     */</em>
<a name="731" href="#731">731</a>     <strong>private</strong> <strong>static</strong> String addTableToFromClause(
<a name="732" href="#732">732</a>             <strong>final</strong> String tableName,
<a name="733" href="#733">733</a>             <strong>final</strong> <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> criteria,
<a name="734" href="#734">734</a>             <a href="../../../../org/apache/torque/util/Query.html">Query</a> query)
<a name="735" href="#735">735</a>     {
<a name="736" href="#736">736</a>         String tableNameForFromClause
<a name="737" href="#737">737</a>                 = getTableNameForFromClause(tableName, criteria);
<a name="738" href="#738">738</a> 
<a name="739" href="#739">739</a>         <a href="../../../../org/apache/torque/util/UniqueList.html">UniqueList</a> queryFromClause = query.getFromClause();
<a name="740" href="#740">740</a> 
<a name="741" href="#741">741</a>         <em class="comment">// it is important that this piece of code is executed AFTER</em>
<a name="742" href="#742">742</a>         <em class="comment">// the joins are processed</em>
<a name="743" href="#743">743</a>         <strong>if</strong> (!fromClauseContainsTableName(
<a name="744" href="#744">744</a>             queryFromClause,
<a name="745" href="#745">745</a>             tableNameForFromClause))
<a name="746" href="#746">746</a>         {
<a name="747" href="#747">747</a>             Query.FromElement fromElement
<a name="748" href="#748">748</a>                     = <strong>new</strong> Query.FromElement(
<a name="749" href="#749">749</a>                             tableNameForFromClause, <strong>null</strong>, <strong>null</strong>);
<a name="750" href="#750">750</a>             queryFromClause.add(fromElement);
<a name="751" href="#751">751</a>         }
<a name="752" href="#752">752</a>         <strong>return</strong> tableNameForFromClause;
<a name="753" href="#753">753</a>     }
<a name="754" href="#754">754</a> 
<a name="755" href="#755">755</a>     <em>/**<em>*</em></em>
<a name="756" href="#756">756</a> <em>     * Inner Interface that defines the Callback method for</em>
<a name="757" href="#757">757</a> <em>     * the Table creation loop.</em>
<a name="758" href="#758">758</a> <em>     */</em>
<a name="759" href="#759">759</a>     <strong>public</strong> <strong>interface</strong> TableCallback
<a name="760" href="#760">760</a>     {
<a name="761" href="#761">761</a>         <em>/**<em>*</em></em>
<a name="762" href="#762">762</a> <em>         * Callback Method for getTableSet()</em>
<a name="763" href="#763">763</a> <em>         *</em>
<a name="764" href="#764">764</a> <em>         * @param tables The current table name</em>
<a name="765" href="#765">765</a> <em>         * @param key The current criterion key.</em>
<a name="766" href="#766">766</a> <em>         * @param crit The Criteria used in getTableSet()</em>
<a name="767" href="#767">767</a> <em>         */</em>
<a name="768" href="#768">768</a>         <strong>void</strong> process(Set tables, String key, <a href="../../../../org/apache/torque/util/Criteria.html">Criteria</a> crit);
<a name="769" href="#769">769</a>     }
<a name="770" href="#770">770</a> 
<a name="771" href="#771">771</a>     <em>/**<em>*</em></em>
<a name="772" href="#772">772</a> <em>     * Inner Interface that defines the Callback method for</em>
<a name="773" href="#773">773</a> <em>     * the buildQuery Criterion evaluation</em>
<a name="774" href="#774">774</a> <em>     */</em>
<a name="775" href="#775">775</a>     <strong>public</strong> <strong>interface</strong> QueryCallback
<a name="776" href="#776">776</a>     {
<a name="777" href="#777">777</a>         <em>/**<em>*</em></em>
<a name="778" href="#778">778</a> <em>         * The callback for building a query String</em>
<a name="779" href="#779">779</a> <em>         *</em>
<a name="780" href="#780">780</a> <em>         * @param criterion The current criterion</em>
<a name="781" href="#781">781</a> <em>         * @param params The parameter list passed to buildQueryString()</em>
<a name="782" href="#782">782</a> <em>         * @return WHERE SQL fragment for this criterion</em>
<a name="783" href="#783">783</a> <em>         */</em>
<a name="784" href="#784">784</a>         String process(Criterion criterion, List params);
<a name="785" href="#785">785</a>     }
<a name="786" href="#786">786</a> 
<a name="787" href="#787">787</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

